package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.SaleUserAddDTO;
import org.jsola.hr.dto.SaleUserUpdateDTO;
import org.jsola.hr.query.SaleUserQuery;
import org.jsola.hr.vo.SaleUserListVO;
import org.jsola.hr.vo.SaleUserVO;

import java.util.List;

/**
 * 销售人员
 *
 * @author zhr
 */
@Api(tags = "hr-销售人员")
public interface ISaleUserControllerAPI {

    /**
     * 新增销售人员
     * @param saleUserAddDTO 销售人员新增实体
     * @return 销售人员展示对象
     */
    @ApiOperation(value = "新增销售人员")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "saleUserAddDTO", dataType = "SaleUserAddDTO", value = "新增销售人员", paramType = "body")
    })
    Result<SaleUserVO> save(SaleUserAddDTO saleUserAddDTO);


    /**
     * 修改销售人员
     * @param saleUserUpdateDTO 销售人员
     * @return 更新数量
     */
    @ApiOperation(value = "修改销售人员")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "saleUserUpdateDTO", dataType = "SaleUserUpdateDTO", value = "修改销售人员", paramType = "body")
    })
    Result<Integer> update(SaleUserUpdateDTO saleUserUpdateDTO);




    /**
     * 删除单个销售人员，彻底删除
     * @param saleUserId 销售人员id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个销售人员，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "saleUserId", dataType = "String", value = "销售人员id", paramType = "path")
    })
    Result<Integer> delete(String saleUserId);


    /**
     * 批量删除销售人员，彻底删除
     * @param saleUserIds 销售人员id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除销售人员，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "saleUserIds", dataType = "String[]", value = "销售人员id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] saleUserIds);


    /**
     * 根据销售人员id查询销售人员详情
     * @param saleUserId 销售人员id
     * @return 销售人员详情
     */
    @ApiOperation(value="根据销售人员id查询销售人员详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "saleUserId", dataType = "String", value = "销售人员id", paramType = "path")
    })
    Result<SaleUserVO> findById(String saleUserId);


    /**
     * 查询销售人员
     * @param saleUserQuery 销售人员查询参数
     * @return page
     */
    @ApiOperation(value="查询销售人员")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "saleUserQuery", dataType = "SaleUserQuery", value = "销售人员查询参数", paramType = "query")
    })
    Result<List<SaleUserListVO>> listAll(SaleUserQuery saleUserQuery);


     /**
     * 分页查询销售人员
     * @param saleUserQuery 销售人员查询参数
     * @return page
     */
    @ApiOperation(value="分页查询销售人员")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "saleUserQuery", dataType = "SaleUserQuery", value = "销售人员查询参数", paramType = "query")
    })
    Result<Page<SaleUserListVO>> page(SaleUserQuery saleUserQuery);


}

